Skip to main content
Version: 3.8

Version Management

Version management in THAPIM entails creating and maintaining multiple API versions to accommodate upgrades and changes while ensuring backward compatibility and smooth transitions for developers and consumers.

Create New API Version​

info

You can add newer versions to an existing API regardless of its state (Draft, Approved, Published, Deprecated, or Retired).

  1. Navigate to the API's Configuration page.

addapiversion

  1. Click the Cogwheel icon.

The drop down appears as shown below.

addapiversion1

  1. Click Add Version.

The Add Version dialog box appears as shown below.

  1. Enter Version number and Version notes.
info

Enter the Version number in x.y format.

Example: 1.1, 2.0, 3.0, etc.

  1. Select Copy from version from the drop down.
info

The Copy From Version drop down shows all of the API's previous versions. Alternatively, select None to add a version without duplicating the data.

  1. Click Add.

Once an API is added, a new version is created and displayed on the API Configuration screen, as shown below.

addapiversion3

Switch between API versions​

If there are multiple versions of an API, you can switch between them to work on a different one.

  1. Navigate to the API's Configuration page.

addapiversion

  1. Click the Cogwheel icon.

The drop down appears as shown below.

apiversion

  1. Click on the version you wish to work on.

The API Configuration page updates automatically to display data from the specified API version.

apiversion1

Delete a draft API Version​

info

Only draft versions of APIs can be deleted.

  1. Navigate to the API's Configuration page.

addapiversion

  1. Click the Cogwheel icon.

The drop down appears as shown below.

deleteadraftapiversion

  1. Click Delete Version.
caution

If there are multiple API versions, clicking Delete version deletes the version in which the user is currently working.

info

For example, The user is currently working with version 1.1 and pressing Delete version deletes the 1.1 version.

The Delete Version dialog box appears as shown below.

deleteadraftapiversion1

  1. Click OK.

On proceeding, the confirmation message appears as shown below.

deleteadraftapiversion2

Manage Visibility of an API​

You can control which Publisher Group(s) have access to an API Version.

  1. Navigate to the API's Configuration page.

addapiversion

  1. Click the Cogwheel icon.

The drop down appears as shown below.

apimanagevisibility

  1. Click Manage Visibility.

The API Visibility dialog box appears as shown below.

  1. Enable/disable the checkbox for the respective publisher group.

  2. Click Submit.

On submitting, the confirmation message appears as shown below.

apimanagevisibility

Edit API Name​

You can edit the name of an API regardless of its API state.

  1. Navigate to the API's Configuration page.

addapiversion

  1. Click the Cogwheel icon.

The drop down appears as shown below.

editapiname

  1. Click Edit API Name.

  1. Enter API Name.

  2. Click Update.

Upon updating, the confirmation message appears as shown below.

editapiname

info

The API name has been modified and is now displayed on the API listing and configuration page.

Submit API for Approval​

A draft API has to be sent for approval. After approval, the API's status switches to Approved.

  1. Navigate to the API's Configuration page.

addapiversion

  1. Click the Cogwheel icon.

The drop down appears as shown below.

submitapiforapproval

  1. Click Submit for approval.
info

If the login user has the Automatic Approval Workflow enabled, the Approve button will appear instead of Submit for approval.

  • Click Approve button to approve an API

On submitting, the confirmation message appears as shown below.

submitapiforapproval1

info

Once an approved API has been synced to the Gateway, it becomes a published API.

Submit API for deprecation​

Only published or approved APIs can be deprecated.

  1. Navigate to the API's Configuration page.

addapiversion

  1. Click the Cogwheel icon.

The drop down appears as shown below.

submitapifordeprecation

  1. Click Submit for deprecation.
info

If the login user has the Automatic Approval Workflow enabled, the Deprecate button will appear instead of Submit for deprecation.

  • Click Deprecate button to deprecate an API

The dialog box appears as shown below.

  1. Click OK.

On proceeding, the status of the API is updated as shown below.

submitapifordeprecation2

Submit for Retirement​

Only deprecated API versions can be retired.

  1. Navigate to the API's Configuration page.

addapiversion

  1. Click the Cogwheel icon.

The drop down appears as shown below.

submitapiforretirement

  1. Click Submit for Retirement.
info

If the login user has the Automatic Approval Workflow enabled, the Retire button will appear instead of Submit for Retirement.

  • Click Retire button to retire an API

On submitting, the status of an API is updated as shown below.

submitapiforretirement1

Submit version for edit​

API versions that have been approved and published cannot be edited. To edit such APIs, use the "Submit version for edit" option.

  1. Navigate to the API's Configuration page.

addapiversion

  1. Click the Cogwheel icon.

The drop down appears as shown below.

submitapiversionforedit

  1. Click Submit version for edit.
info

If the login user has the Automatic Approval Workflow enabled, the Open for Editing button will appear instead of Submit version for edit.

  • Click Open for Editing button to edit an API.

On submitting, the status of an API is updated as shown below.

submitapiversionforedit1

Once approved, the API's state changes back to Draft. You can now proceed and edit the API.

Discard Draft after open for edit​

You can discard the draft changes and return to the previously approved or published API Version. This nullifies any changes made while changing the API version after it has been opened for editing.

  1. Navigate to the API's Configuration page.

addapiversion

  1. Click the Cogwheel icon.

The drop down appears as shown below.

discardapidraft

  1. Click Discard draft.

On proceeding, the API changes nullify and gone back to the previous state.

discardapidraft1

Export an approved and published APIs​

  1. Navigate to the API's Configuration page.

  2. Click the Cogwheel icon.

The drop down appears as shown below.

exportapi

  1. Click Export.

The Export Versions dialog box appears as shown below.

info

The Export Versions dialog box displays only approved and published API(s).

  1. Select the version that needs to be exported.

  2. Click Export to download the selected API version in zip format.

On exporting, the confirmation message appears as shown below.

exportapi2

Import an approved and published APIs​

  1. Navigate to the API's Configuration page.

importapi

  1. Click the Cogwheel icon.

The drop down appears as shown below.

importapi1

  1. Click Import.

The Import Versions dialog box appears as shown below.

importapi2

info

There are two methods for importing Approved and Published APIs:

  • Full Import - The existing artifacts will be removed from this deployment and the artifacts in the imported file shall be populated. SSL certificates, if any, must be manually configured.

  • Delta Import - If the artifact being imported already exists in this instance, it will be updated with the information from the imported file. Artifacts present in this instance but not in the imported file will be left untouched. If the artifact being imported does not exist in this instance, it will be created. SSL certificates, if any, must be configured manually.

  1. Click the Upload File to Import button to import the file from your local disk.

On uploading, the Import Versions dialog box updated as shown below.

importapi3

  1. Select the New Version to be imported by selecting the relevant checkbox.

  2. Select the Import method as either Full Import or Delta Import as per the requirement.

  3. Click Import.

On importing, the confirmation message appears as shown below.

importapi4